<!DOCTYPE HTML>

<html lang="en">
<head>

<title>OAuth2User (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="OAuth2User (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="OAuth2User.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="OAuth2User.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.oauth2.core.user</a></div>
<h2 title="Interface OAuth2User" class="title">Interface OAuth2User</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="../../../core/AuthenticatedPrincipal.html" title="interface in org.springframework.security.core">AuthenticatedPrincipal</a></code>, <code><a href="../OAuth2AuthenticatedPrincipal.html" title="interface in org.springframework.security.oauth2.core">OAuth2AuthenticatedPrincipal</a></code></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="../oidc/user/OidcUser.html" title="interface in org.springframework.security.oauth2.core.oidc.user">OidcUser</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="DefaultOAuth2User.html" title="class in org.springframework.security.oauth2.core.user">DefaultOAuth2User</a></code>, <code><a href="../oidc/user/DefaultOidcUser.html" title="class in org.springframework.security.oauth2.core.oidc.user">DefaultOidcUser</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">OAuth2User</span>
extends <a href="../OAuth2AuthenticatedPrincipal.html" title="interface in org.springframework.security.oauth2.core">OAuth2AuthenticatedPrincipal</a></pre>
<div class="block">A representation of a user <code>Principal</code> that is registered with an OAuth 2.0
Provider.
<p>
An OAuth 2.0 user is composed of one or more attributes, for example, first name,
middle name, last name, email, phone number, address, etc. Each user attribute has a
&quot;name&quot; and &quot;value&quot; and is keyed by the &quot;name&quot; in
<a href="../OAuth2AuthenticatedPrincipal.html#getAttributes()"><code>OAuth2AuthenticatedPrincipal.getAttributes()</code></a>.
<p>
<b>NOTE:</b> Attribute names are <b>not</b> standardized between providers and
therefore will vary. Please consult the provider's API documentation for the set of
supported user attribute names.
<p>
Implementation instances of this interface represent an
<a href="../OAuth2AuthenticatedPrincipal.html" title="interface in org.springframework.security.oauth2.core"><code>OAuth2AuthenticatedPrincipal</code></a> which is associated to an <a href="../../../core/Authentication.html" title="interface in org.springframework.security.core"><code>Authentication</code></a>
object and may be accessed via <a href="../../../core/Authentication.html#getPrincipal()"><code>Authentication.getPrincipal()</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="DefaultOAuth2User.html" title="class in org.springframework.security.oauth2.core.user"><code>DefaultOAuth2User</code></a>,
<a href="../OAuth2AuthenticatedPrincipal.html" title="interface in org.springframework.security.oauth2.core"><code>OAuth2AuthenticatedPrincipal</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.springframework.security.core.AuthenticatedPrincipal">

</a>
<h3>Methods inherited from interface&nbsp;org.springframework.security.core.<a href="../../../core/AuthenticatedPrincipal.html" title="interface in org.springframework.security.core">AuthenticatedPrincipal</a></h3>
<code><a href="../../../core/AuthenticatedPrincipal.html#getName()">getName</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.springframework.security.oauth2.core.OAuth2AuthenticatedPrincipal">

</a>
<h3>Methods inherited from interface&nbsp;org.springframework.security.oauth2.core.<a href="../OAuth2AuthenticatedPrincipal.html" title="interface in org.springframework.security.oauth2.core">OAuth2AuthenticatedPrincipal</a></h3>
<code><a href="../OAuth2AuthenticatedPrincipal.html#getAttribute(java.lang.String)">getAttribute</a>, <a href="../OAuth2AuthenticatedPrincipal.html#getAttributes()">getAttributes</a>, <a href="../OAuth2AuthenticatedPrincipal.html#getAuthorities()">getAuthorities</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="OAuth2User.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="OAuth2User.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040d9754fc7980c","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
